home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / comm / cnet / cdaxe_103.lha / CDAxe.doc < prev    next >
Text File  |  1995-09-04  |  15KB  |  355 lines
  1.                                 CDAxe v1.03
  2.                                -=-=-=-=-=-=-
  3.            Coded by Ray Akey (aka Heavy Metal) of Metal Software
  4.                  Using the SAS/C Development System v6.55
  5.  
  6.  
  7.       NOTE: Although this software is not crippled, it is SHAREWARE!
  8.             If you use it for more than one week, you must REGISTER
  9.             it!  Registration is only $20.00 U.S. or $25.00 Canadian.
  10.                            SUPPORT AMIGA DEVELOPERS!
  11.  
  12.          Send your cheque or money order for registration to:
  13.  
  14.             Ray Akey
  15.             411 Bridge Ave.
  16.             Windsor, ON
  17.             Canada  N9B 2M3
  18.  
  19.  
  20. Changes/Bug fixes v1.03/1.02
  21. ============================
  22. 1. NOW GLOBALLY OPTIMIZED FOR SPEED!
  23. 2. (1.02) readme's are now "auto-selected" when a user selects a file that has
  24.    an existing .readme file (may be a user configurable option later).
  25. 3. (1.02) "files.bbs" is now searched for and parsed for descriptions BEFORE
  26.    .readme's.  If a files.bbs description is found, no .readme is searched
  27.    for.
  28. 4. "files.txt" is now searched for and parsed for descriptions BEFORE
  29.    .readme's but after files.bbs. If a files.txt description is found, no
  30.    files.bbs or .readme is seeked for that file/dir.
  31. 5. (1.02) Added sysop feature of changing/adding a file/directory-note using
  32.    the CTRL-I key combination.
  33. 6. Added sysop feature of listing devices/volumes using the CTRL-L key
  34.    combination.
  35.  
  36.  
  37. Changes/Bug fixes v1.01
  38. =======================
  39. 1.  FIXED! -> CDRom temp path enabled was not allowing selected files to be
  40.               downloaded.
  41. 2.  Debug output text removed (oops!)
  42. 3.  The old "AMINET" and "NOAMINET" keywords have been changed to "DIRDESC"
  43.     and "NODIRDESC", respectively.
  44. 4.  New keywords "CDROM" and "NOCDROM" added for command line enable/disable
  45.     of CDROM Temp path.  These are MAINT keywords.  See the section of these
  46.     docs titled "Command Line Arguments" if you need to know about overriding
  47.     MAINT keywords in BBSMENU/pfile specifications.
  48. 5.  Directory comments are now external.  Edit SYSDATA:CDAxe.DirInfo to
  49.     add to the included aminet directory descriptions. (see the note below)
  50.  
  51.     NOTE: the directory name comparison is a right-hand compare so make sure
  52.           that SHORTER dir names are placed at the bottom of the file.
  53.           You'll notice that in the included default file, "misc" is toward
  54.           the bottom while "biz/misc" is higher up..  If this were not so,
  55.           the description for "misc" may be mistaken as a description for
  56.           "biz/misc" as the last four characters on the RIGHT hand end of
  57.           the string match that directory name.
  58.  
  59.           In general, you may assume that directory names with many "levels"
  60.           should be at the top, while single level directory names should be
  61.           at the bottom so that they are check last.
  62.  
  63.           The FIRST match found will be the one used by CDAxe.
  64.  
  65.           ALSO, you may be SURE that (for example) aminet directories only use
  66.           aminet dir names by using a more precise path.
  67.           ie. "aminet/biz/dbase" rather than "biz/dbase".  The more "nodes" or
  68.           "levels" you supply, the more picky CDAxe will be about tagging on
  69.           directory comments.
  70.  
  71.           If you do not have Aminet CD's or an aminet style "mirror" on your
  72.           system, you can just delete the existing default directory
  73.           descriptions and create your own.  I have been told by a local beta
  74.           tester than he is going to use CDAxe as a replacement for CNet's
  75.           SCAN..  In this case, he/you would want to comment the names of your
  76.           CNet UDBases appropriately.  Also note that you should not have any
  77.           "private" directories in a "CDAxe" path as there are no restrictions
  78.           on "child directory" access other than what you configure in CDAxe
  79.           Config.
  80.  
  81.           PS. The term "Child directory" refers to directories that are
  82.           existent in the path that you specify to be used by CDAxe, not
  83.           directories created for children.  8-/
  84.  
  85.  
  86.  
  87.  
  88.  
  89.                                 What is it?
  90.                                 ===========
  91.    CDAxe is a very powerful directory/device util for CNet Amiga v3.05c.
  92. Although CDAxe is specifically designed to provide your users with a very
  93. easy way to traverse the many directories that exist on most CD-ROMs, it has
  94. applications in other areas as well.  Since, as is standard with MetalSoft
  95. programs, CDAxe is so configurable, YOU decide what path it will use as it's
  96. "startup directory".
  97.  
  98.  
  99.  
  100.  
  101.                                  Features:
  102.                                  =========
  103.    - Sysop definable number of buffered directories.
  104.    - Parent function will not recede further back than the "startup directory"
  105.      unless the user has SYSOP MAINT.
  106.    - Remembers the last position of the file/directory selector on buffered
  107.      directories so user does not lose his/her place when traversing through
  108.      directories.
  109.    - Configuration via CNet Visual Data Editor (VDE)
  110.    - Configurable access groups allowed to enter/use.
  111.    - Configurable access flags allowed to enter/use.
  112.    - Configurable minimum and maximum age allowed to enter/use.
  113.    - configurable gender allowed to enter/use.
  114.    - configurable file/byte percent charges (100% = charge byte per byte/file per
  115.      file).
  116.    - show or hide .info files.
  117.    - show or hide .readme files.
  118.    - choice to display DIRECTORY descriptions.
  119.    - read *.txt, *.doc, *.nfo, files.bbs, index files while in the CDAxe
  120.      interface.
  121.    - CNet CDRom temp path supported.
  122.    - capable of emulating "no maint" operation for sysop testing of how
  123.      CDAxe will act when a non-sysop uses it.
  124.    - CD "[N]ew directory" command to change directories internally as a SYSOP
  125.      feature, available only to maint users.
  126.    - COPY command to copy the currently highlighted file to another location.
  127.      This is a feature requiring sysop maint.
  128.    - MOVE command to move the currently highlighted file to another location.
  129.      This is a feature requiring sysop maint.
  130.    - MAKEDIR command to create a new directory. (requires SYSOP MAINT)
  131.    - DELETE command to remove files from the current directory. (requires
  132.      SYSOP MAINT)
  133.    - when the ENTER key is used to read, select or examine a file, CDAxe
  134.      performs actions based on file type.
  135.    - filetypes other than than CDAxe defined ASCII text are viewed using your
  136.      configured CNet ARCHIVERs.
  137.  
  138.  
  139.      Currently, the following types/extensions are recognized as readable
  140.      ASCII text and are displayed as such:
  141.  
  142.       *.doc
  143.       *.nfo
  144.       *.txt
  145.       *.wri
  146.       *.readme
  147.       files.bbs
  148.       index
  149.       readme
  150.  
  151.  
  152.  
  153.  
  154.  
  155.                             Basic Installation
  156.                             ==================
  157. 1.  Copy CDAxe to a suitable location.  I use PFILES:.
  158. 2.  Copy CDAxeCfg_VDE to sysdata:vde/.
  159. 3.  Copy the contents of the HELP/ directory to SYSDATA:HELP/
  160. 3.  Add the following text/command to your BBSMENU at the end of the section
  161.     titled "2; Available everywhere":
  162.  
  163.          CDAXE   |#2pfiles:system/CDAxe}
  164.  
  165. 4.  Logon and enter "CDAXE CONFIG" to use configure CDAxe using the CNet VDE.
  166.  
  167.  
  168.  
  169.  
  170.                          "DIR" command replacement
  171.                          =========================
  172. If you wish CDAxe to replace your DIR command for Direct Exchange subboards,
  173. do the following IN ADDITION TO the steps listed in "Basic Installation".
  174.  
  175. 1.  Add the following two lines to your BBSMENU at the VERY END of the
  176.     section titled "4; ud/base":
  177.  
  178.       CDAXE     |#2pfiles:system/CDAxe DIRECT}
  179.       DIR~CDAXE DIRDESC READMEDESC NOINFO NOSHOWREADME NOPROMPT
  180.  
  181.     (see the section titled "CONFIG OPTIONS" for information about the
  182.      CDAxe keywords used above)
  183.  
  184. 2.  disable the old CNet dir command by replacing the command "DIR" (found in
  185.     the same section in BBSTEXT) with "!DIR"
  186. 3.  Use the Cnet Config RELOAD TEXT menu to put these changes into effect.
  187.  
  188.  
  189.  
  190.  
  191.                               Config Options
  192.                               ==============
  193. This section gives some insight into some of CDAXe's configuration options.
  194.  
  195.       
  196.  
  197. Device/Path     : The default device/directory to read.
  198. Entry Access    : The access groups allowed to enter/use CDAxe.
  199. Entry Flags     : The Files base flags that users must have set on their account.
  200. Youngest/Oldest : The ages range that can access CDAxe.
  201. Gender          : Sex?  What's sex? ;)
  202. Byte Charge     : The PERCENT of the byte size to charge the user.
  203.                   100 = charge user full credit.  200 = charge user 2x the byte
  204.                   size.
  205. File Charge     : The PERCENT of a file credit to charge a user.  100=1 file
  206.                   credit,  200=2 file credits, etc,..
  207. CDRom Temp      : Files are copied to your CDRom temp directory as specified
  208.                   by your CNet configuration.
  209. Sort Order      : Alpha = Alphabetical file/dir sort.
  210.                   Chrono = sort by descending date (newest first).
  211.                   Rev Chrono = sort by ascending date (newest last)
  212.                   (note: a SIZE sort is available as a COMMAND LINE/argument)
  213. Show .info files: Show or hide icon (.info) files.
  214. Show .readme's  : Show or hide description (.readme) files.
  215. Desc from readme: If set to YES, CDAXe will attempt to extract the "SHORT"
  216.                   field from aminet description files and use that as the
  217.                   "filenote" that is displayed as the file comment.
  218. Use dir descript: If enabled, uses directory comments.
  219.                   (ie. comm/misc = Miscellaneous communications")
  220. Free Download   : If true, all files selected with CDAxe are free downloads.
  221. Max disk buffers: The number of directories to buffer.  if set to 10, the
  222.                   last ten directories you viewed/wntered are kept in RAM to
  223.                   reduce disk access and. ultimately, make CDAxe more
  224.                   efficient.
  225.  
  226.  
  227. NOTE: All options can be overridden by command line arguments, except for the
  228. following:
  229.  
  230.    Gender
  231.    Youngest
  232.    Oldest
  233.    Entry Access
  234.    Entry Flags
  235.    Byte Charge
  236.    File Charge
  237.    Move to CDRom temp
  238.  
  239.  
  240.  
  241.  
  242.       Command Line Arguments (* denotes an arg requiring SysOp Maint)
  243.       ===============================================================
  244. PFile specification:  This term is used to differentiate between the actual
  245.                       pfile DEFINE and a command alias. See below.
  246.  
  247. a pfile specification ->  Mycommand  |#2mycommandspec}
  248. another --------------->  Mycommand  |#2anothercommandspec <arg1> <arg2>}
  249.  
  250. a command/alias ------->  DIR~Mycommand
  251.  
  252.  
  253.  
  254. NOTE: arguments can be specified both on the CNet command line prompts and
  255.       on BBSMENU.  To FORCE a SysOp maint argument on a user that doesn't have
  256.       SYSOP MAINT, add it in the pfile specification rather than in the
  257.       CNet "replacement" command.
  258.  
  259.       example 1:  to force a DIRECT EXCHANGE subboard use the "DIRECT"
  260.                   argument which is an argument that requires SYSOP MAINT:
  261.  
  262.          CDAXE     |#2pfiles:system/CDAxe DIRECT}
  263.          DIR~CDAXE
  264.  
  265.  
  266.                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ pfile specification
  267.  
  268.       rather than the following which does not work:
  269.  
  270.          CDAXE     |#2pfiles:system/CDAxe}
  271.          DIR~CDAXE DIRECT
  272.  
  273.  
  274.       example 2.  to force a device/directory name other than that in the
  275.                   CDAxe configuration, place the device/pathname as a command
  276.                   argument in the pfile specification:
  277.  
  278.          CDAXE     |#2pfiles:system/CDAxe <path>}
  279.          DIR~CDAXE
  280.  
  281.       rather than using the following (remember! the above spec works, the one
  282.       below is an example of IMPROPER use of SYSOP MAINT arguments):
  283.  
  284.          CDAXE     |#2pfiles:system/CDAxe}
  285.          DIR~CDAXE <path>
  286.  
  287.  
  288.  
  289.  
  290.                                Argument list
  291.                                =============
  292. ( + denotes a NEW/changed keyword for this release )
  293.  
  294. *CONFIG        - Set CDAxe configuration options.
  295.  NOMAINT       - Causes CDAxe to emulate NO MAINT operation to verify what regular
  296.                  users would see.
  297.  DIRDESC       - Causes descriptions to be tagged on directories.
  298.                  (previously, DIRDESC was the AMINET keyword)
  299.                  (define your directory descriptions in SYSDATA:cdaxe/dirinfo)
  300.  NODIRDESC     - Turns off directory descriptions.
  301.                  (previously, NODIRDESC was the NOAMINET keyword)
  302. *DIRECT        - used in conjunction with Direct Exchange subboards.  Causes
  303.                  CDAxe to use the path specified in the Subbard "EL".
  304. *NODIRECT      - Turns off Direct Exchange operation.
  305.  READMEDESC    - Causes CDAxe to use the aminet "SHORT" descriptions for filenotes.
  306.  NOREADMEDESC  - Turns off aminet short description capability.
  307.  INFO          - Causes CDAXE to SHOW .info files.
  308.  NOINFO        - CDAxe does not show .info files.
  309.  SHOWREADME    - CDAxe shows .readme files.
  310.  SORTCHRONO    - sorts listings by descending date (newest first)
  311.  SORTREV       - sorts listings by ascending date (oldest first)
  312.  SORTSIZE      - sorts listings by size (smallest first)
  313.  SORTALPHA     - sorts listings alphabetically
  314.  NOPROMPT      - forces CDAxe to skip the sysop "Enter a device/path" prompt.
  315.                  (this prompt is only available to users with SYSOP MAINT but
  316.                   this argument is provided for feature's sake ..)
  317. *CDROM         - (New for v1.01) command line enable of CD-ROM temp path.
  318. *NOCDROM       - (New for v1.01) command line disable of CD-ROM temp path.
  319.  <path>        - ANY ARGUMENT given, that is not a VALID CDAxe argument, will
  320.                  be assumed to be a device/path to read.  This path is only
  321.                  used if the user has SYSOP MAINT (OR) if the extra path
  322.                  argument is specified in BBSMENU in the pfile specification.
  323.  
  324.  
  325.  
  326.  
  327.  
  328. NOTES: (1) files.bbs and/or files.txt must exist in the CURRENT directory (ie.
  329.            the directory for which the current file list is displayed) or
  330.            it will not be found.
  331.        (2) files.txt was added as a suggestion from Todd H. Knight as
  332.            it was found on a CD that contains .GIF pictures. It is
  333.            further noted that files.txt contains descriptions in the same
  334.            format as that of files.bbs. (ie filename <whitespace> description)
  335.  
  336.  
  337.  
  338.  
  339.                             KNOWN BUGS/PROBLEMS
  340.                             ===================
  341. This is really NOT a bug but it's quirky from the sysop side so..
  342. If a remote user is using CDAxe and his termlength is set higher than that
  343. of the Sysop's local screen, scrolling may APPEAR to be functioning
  344. improperly from the Sysop side.  To be sure that it is indeed operating
  345. correctly, put your local screen in FULL LACE mode and the display should then
  346. look ok on the sysop side.  However, for the user side, fear not, the display
  347. scrolls 100% according to the current user's TERMLENGTH setting in CNet's "ET"
  348. settings.  If your user(s) complain that the program is not operating properly
  349. with regard to scrolling, inform them that their "ET" SCREEN HEIGHT must be
  350. set to EXACTLY the number displayed at the top of his/her screen after CNet
  351. does it's usual count sequence when the user changes his screen height
  352. setting.
  353.  
  354.  
  355.